/*
 * Copyright (C) 2021 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.sentry.spring.tracing;

import io.sentry.protocol.SentryTransaction;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.annotation.AliasFor;

/**
 * Makes annotated method execution or a method execution within a class annotated with {@link
 * SentrySpan} executed within running {@link SentryTransaction} to get wrapped into {@link
 * io.sentry.Span}.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface SentrySpan {

    /**
     * Span description.
     *
     * @return description
     */
    String description() default "";

    /**
     * Span operation. If not set, operation is resolved as a class name and a method name.
     *
     * @return operation.
     */
    @AliasFor("value")
    String operation() default "";

    /**
     * Span operation. If not set, transaction name is resolved as a class name and a method name.
     *
     * @return operation.
     */
    @AliasFor("operation")
    String value() default "";
}
